IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/Vk/VkCheckBox.z/VkCheckBox

Text File | 2002-10-03 | 9.5 KB | 265 lines

VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))                                                  VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))



NNNNAAAAMMMMEEEE
     VkCheckBox - A simple interface to a multi-choice preference panel

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     VkComponent : VkCallbackObject

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <Vk/VkCheckBox.h>

PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
   CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
           VkCheckBox(const char* name, Widget parent);
           virtual void ~VkCheckBox(void);


   AAAAddddddddiiiinnnngggg iiiitttteeeemmmmssss
           Widget addItem(char* name, Boolean set = 0,
                          XtCallbackProc proc = NULL,
                          XtPointer clientData = NULL);


   SSSSeeeettttttttiiiinnnngggg aaaannnndddd GGGGeeeettttttttiiiinnnngggg SSSSttttaaaatttteeee
           void setValue(int index, Boolean newValue);
           void setValues(Boolean* values, int numValues);
           int getValue(int index);


PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
   DDDDeeeetttteeeeccccttttiiiinnnngggg SSSSttttaaaatttteeee CCCChhhhaaaannnnggggeeeessss
           virtual void valueChanged(int index, Boolean newValue);


   PPPPrrrrooootttteeeecccctttteeeedddd DDDDaaaattttaaaa MMMMeeeemmmmbbbbeeeerrrrssss
           WidgetList _widgetList;
           Widget _rc, _label;


CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
          The VkCheckBox class offers a simple interface for creating a set of
          check boxes. Instantiating the component creates an empty, labeled
          component that contains a Motif XmRowColumn widget. Adding items via
          the _a_d_d_I_t_e_m() member function creates XmToggleButton widgets to be
          added to the XmRowColumn widget. The state of any individual check
          item can be set using the _s_e_t_V_a_l_u_e() or _s_e_t_V_a_l_u_e_s() member
          functions. The current value of any item can be queried using
          _g_e_t_V_a_l_u_e(). The class also supports a virtual member function that
          can notify derived classes when the state of any item changes.  The
          class can also be used directly using the _V_k_C_h_e_c_k_B_o_x::_i_t_e_m_C_h_a_n_g_e_d()
          ViewKit callback.






                                                                        PPPPaaaaggggeeee 1111






VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))                                                  VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))





DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
          Derived classes can be notified of changes to the state of any item
          by overriding the _v_a_l_u_e_C_h_a_n_g_e_d() member function. Derived classes
          also have access to the __w_i_d_g_e_t_L_i_s_t member, which contains the
          toggle buttons added to the checkbox, as well as the rowcolumn
          widget __r_c that holds the toggle buttons and the label widget __l_a_b_e_l
          supported by this class.



FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
   vvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeedddd(((())))
           virtual void valueChanged(int index, Boolean newValue);


          This virtual member function is called when the state of any item in
          the checkbox changes. The arguments indicate the index of the item
          that has changed and the current (new) value of that item.

   VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx(((())))
           VkCheckBox(const char* name, Widget parent);


          Initialize the VkCheckBox object. Various manager widgets are
          created to support the items in the checkbox.

   ~~~~VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx(((())))
           virtual void ~VkCheckBox(void);


          Free all storage associated with a VkCheckBox object.

   aaaaddddddddIIIItttteeeemmmm(((())))
           Widget addItem(char          *name,
                         Boolean        initialValue = 0,
                         XtCallbackProc callback     = NULL,
                         XtPointer      clientData   = NULL);


          Add a new item to the checkbox. Create an XmToggleButton widget,
          whose state is initially set to the given optional value. The
          optional callback must be an Xt-style callback. The _c_l_i_e_n_t_D_a_t_a
          argument, if provided will be passed to the Xt callback when it is
          called. The function returns the XmToggleButton widget that is
          created by this function.

   sssseeeettttVVVVaaaalllluuuueeee(((())))
           void setValue(int index, Boolean newValue);





                                                                        PPPPaaaaggggeeee 2222






VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))                                                  VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))



          Set the value of the item indicated by the _i_n_d_e_x to the given new
          value.

   sssseeeettttVVVVaaaalllluuuueeeessss(((())))
           void setValues(Boolean* values, int numValues);


          Set the values of _n_u_m_V_a_l_u_e_s items at once. The _v_a_l_u_e_s argument is
          expected to be an array of Boolean values of less than or equal to
          the number of items in the check box.

   ggggeeeettttVVVVaaaalllluuuueeee(((())))
           int getValue(int index);


          Retrieve the current value of the specified item.

DDDDAAAATTTTAAAA MMMMEEEEMMMMBBBBEEEERRRR DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
   ____wwwwiiiiddddggggeeeettttssss
           WidgetList _widgets;


          The list of XmToggleButton widgets in the checkbox.

   iiiitttteeeemmmmCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
           static const char* const itemChangedCallback;


          A callback list that is invoked when any item changes state.  The
          index of the item that changed is returned as call data.

IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
   IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources(), VkComponent(), manage(),
          unmanage(), baseWidget(), okToQuit(), _name, _baseWidget, _w,
          deleteCallback


   IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
          callCallbacks(), addCallback(), removeCallback(),
          removeAllCallbacks(),


KKKKNNNNOOOOWWWWNNNN DDDDEEEERRRRIIIIVVVVEEEEDDDD CCCCLLLLAAAASSSSSSSSEEEESSSS
     VkRadioBox

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     VkComponent, VkCheckBox _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
     _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
     _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF



                                                                        PPPPaaaaggggeeee 3333






VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))                                                  VVVVkkkkCCCChhhheeeecccckkkkBBBBooooxxxx((((3333xxxx))))























































                                                                        PPPPaaaaggggeeee 4444